Skip to main content

listBehavior

Type

property

Summary

Specifies whether a locked field behaves as a clickable list.

Syntax

set the listBehavior of <field> to {true | false}

Description

Use the listBehavior property to create a list box.

If a field's listBehavior property is set to true, and the user clicks a line, the entire line is highlighted. The Up and Down arrow keys move the selection up or down.

Normally, the mouseUp and mouseDown messages are sent to the field as usual. However, if the user clicks below the last line of text in the field, a mouseRelease message is sent instead of mouseUp.

You use the hilitedLine property to determine which line the user clicked. The field's hilitedLine is set to the new line before the mouseDown message is sent, so there is no way to determine the previously-selected line.

If the field's autoHilite property is set to false, a clicked line does not highlight, regardless of the listBehavior setting; the field does not behave like a clickable list in this case. However, you can set the hilitedLine of the field even if the field's autoHilite is false.

note

Setting the listBehavior of a field to true will automatically set the field's dontWrap property to true, as a list field cannot have text wrapping. Setting the dontWrap of a list field to false has no effect.

Examples

set the listBehavior of field "Items List" to true
if the listBehavior of me then mouseUp

glossary: property, highlight, lock, message, line, list field, field

keyword: field, selection

message: mouseDown, mouseRelease, mouseUp

object: field

property: noncontiguousHilites, dontWrap, autoHilite, lockText, multipleHilites, threeDHilite, toggleHilites, hilitedLine

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile

Thank you for your feedback!

Was this page helpful?